Hierarchical API for a SDDC

ABSTRACT

Some embodiments of the invention provide a method for deploying software-implemented resources in a software defined datacenter (SDDC). The method initially receives a hierarchical API command that, in a declarative format, specifies several operation requests for several software-defined (SD) resources at several resource levels of a resource hierarchy in the SDDC. The method parses the API command to identify the SD resources at the plurality of resource levels. Based on the parsed API command, the method deploys the SD resources by using a deployment process that ensures that any first SD resource on which a second SD resource depends is deployed before the second resource. In some embodiments, a second SD resource depends on a first SD resource when the second SD resource is a child of the first SD resource. Alternatively, or conjunctively, a second SD resource can also depend on a first SD resource in some embodiments when the second SD resource has some operational dependency on the first SD resource. In some embodiments, the method parses the API command by identifying several sets of SD resources, with each set having one or more SD resources at one resource level. The deployment in some embodiments deploys the identified SD resource sets at higher resource levels before deploying SD resources at lower resource levels.

RELATED APPLICATION CLAIM OF BENEFIT TO PRIOR APPLICATIONS

This application is a continuation application of U.S. patent application Ser. No. 16/945,727, filed Jul. 31, 2020, now published as U.S. Patent Publication 2020/0366558. U.S. patent application Ser. No. 16/945,727 is a continuation application of U.S. patent application Ser. No. 16/200,677, filed Nov. 27, 2018, now issued as U.S. Pat. No. 10,812,337. U.S. patent application Ser. No. 16/200,677 claims benefit under 35 U.S.C. 119(a)-(d) to Indian Patent Application Serial No. 201841022438, entitled “HIERARCHICAL API FOR A SDDC”, filed on Jun. 15, 2018. U.S. patent application Ser. No. 16/945,727, now published as U.S. Patent Publication 2020/0366558, U.S. patent application Ser. No. 16/200,677, now published as U.S. Patent Publication 2019/0386877, and Indian Patent Application 201841022438 are herein incorporated in their entirety by reference for all purposes.

BACKGROUND

Today, software defined datacenters (SDDC) are an important part of private and public clouds. To deploy a resource in SDDC, user typically has to go through several sequential steps in a predefined order. Each of these steps is often implemented through one or more API (Application Programming Interface) commands generated through a graphical user interface or a command line interface.

This tedious sequential set of API commands is often required for both imperative API systems as well as intent-based API systems. The sequential nature of these operations is often required because when resources are associated, one set of resources has to be defined before other sets of resources (e.g., parent resources have to be created before child resources). Ideally, a user should not have to go through such a tedious approach, and instead should be able to create several or all of the software defined (SD) resources in one API command.

BRIEF SUMMARY

Some embodiments of the invention provide a method for deploying software-implemented resources in a software defined datacenter (SDDC). The method initially receives a hierarchical API command that, in a declarative format, specifies several operation requests for several software-defined (SD) resources at several resource levels of a resource hierarchy in the SDDC. The method parses the API command to identify the SD resources at the plurality of resource levels. Based on the parsed API command, the method deploys the SD resources by using a deployment process that ensures that any first SD resource on which a second SD resource depends is deployed before the second resource.

In some embodiments, a second SD resource depends on a first SD resource when the second SD resource is a child of the first SD resource. Alternatively, or conjunctively, a second SD resource can also depend on a first SD resource in some embodiments when the second SD resource has some operational dependency on the first SD resource. In some embodiments, the method parses the API command by identifying several sets of SD resources, with each set having one or more SD resources at one resource level. The deployment in some embodiments deploys the identified SD resource sets at higher resource levels before deploying SD resources at lower resource levels.

Examples of SD resources that can be specified in the hierarchical API command include SD forwarding elements (e.g., managed software switches and routers, logical switches and routers implemented by the managed software switches and routers, etc.), SD compute elements (e.g., virtual machines, containers, etc.), SD service middlebox modules (e.g., service VMs or modules that perform middlebox service operations such as firewall operations, load balancing operations, network address translation operations, encryption operations, intrusion detection operations, intrusion prevention operations, etc.).

In some embodiments, an API processing system processes the API command. This command can include a set of parameters to update an earlier deployed SD resource. When this is the case, the API processing system deploys the SD resources by updating the earlier deployed SD resource based on a set of parameters specified in the parsed API command. In other cases, the API command includes a set of parameters that define a new SD resource. In such a case, the API processing system deploys the SD resource by deploying the SD resource based on the set of parameters specified in the parsed API command.

In some embodiments, the hierarchical API command is processed as one atomic unit. Accordingly, the API processing system determines whether the identified SD resources in the hierarchical API command are deployable. If so, the API processing system sends a confirmation that the API command has been successfully processed to a source that produced the hierarchical API command. On the other hand, when one or more SD resources in the API command are not deployable, the API processing system sends a message that the API command has not been successfully processed to the source that produced the hierarchical API command.

The preceding Summary is intended to serve as a brief introduction to some embodiments of the invention. It is not meant to be an introduction or overview of all inventive subject matter disclosed in this document. The Detailed Description that follows and the Drawings that are referred to in the Detailed Description will further describe the embodiments described in the Summary as well as other embodiments. Accordingly, to understand all the embodiments described by this document, a full review of the Summary, the Detailed Description, the Drawings and the Claims is needed. Moreover, the claimed subject matters are not to be limited by the illustrative details in the Summary, the Detailed Description and the Drawings.

BRIEF DESCRIPTION OF FIGURES

The novel features of the invention are set forth in the appended claims. However, for purposes of explanation, several embodiments of the invention are set forth in the following figures.

FIG. 1 illustrates an example of a hierarchical API command.

FIG. 2 illustrates a process that the API processing system of some embodiments performs to process a hierarchical API command that it receives.

FIG. 3 illustrates an example of the workflow for processing a hierarchical API in some embodiments.

FIG. 4 illustrates an example of the API processing system of some embodiments of the invention.

FIGS. 5A-B illustrate another example of a hierarchical API.

FIG. 6 illustrates yet another example of a hierarchical API.

FIG. 7 illustrates the network components defined by the API of FIG. 6 .

FIG. 8 illustrates a hierarchical API template that can be used to define the hierarchical API.

FIG. 9 illustrates a process that an API processor performs to process a hierarchical API regarding SD resources in the SDDC.

FIG. 10 conceptually illustrates a computer system with which some embodiments of the invention are implemented.

DETAILED DESCRIPTION

In the following detailed description of the invention, numerous details, examples, and embodiments of the invention are set forth and described. However, it will be clear and apparent to one skilled in the art that the invention is not limited to the embodiments set forth and that the invention may be practiced without some of the specific details and examples discussed.

Some embodiments of the invention provide a method for deploying software-implemented resources in a software defined datacenter (SDDC). The method initially receives a hierarchical API command that, in a declarative format, specifies several operation requests for several software-defined (SD) resources at several resource levels of a resource hierarchy in the SDDC. The method parses the API command to identify the SD resources at the plurality of resource levels. Based on the parsed API command, the method deploys the SD resources by using a deployment process that ensures that any first SD resource on which a second SD resource depends is deployed before the second resource.

In some embodiments, a second SD resource depends on a first SD resource when the second SD resource is a child of the first SD resource. Alternatively, or conjunctively, a second SD resource can also depend on a first SD resource in some embodiments when the second SD resource has some operational dependency on the first SD resource. In some embodiments, the method parses the API command by identifying several sets of SD resources, with each set having one or more SD resources at one resource level. The deployment in some embodiments deploys the identified SD resource sets at higher resource levels before deploying SD resources at lower resource levels.

Examples of SD resources that can be specified in the hierarchical API command include SD forwarding elements (e.g., managed software switches and routers, logical switches and routers implemented by the managed software switches and routers, etc.), SD compute elements (e.g., virtual machines, containers, etc.), SD service middlebox modules (e.g., service VMs or modules that perform middlebox service operations such as firewall operations, load balancing operations, network address translation operations, encryption operations, intrusion detection operations, intrusion prevention operations, etc.).

Some embodiments of the invention are implemented by an intent-based API processing system that provides its users with a hierarchical API data model that allows the users to specify their intent (i.e., their SD resources) without worrying about the mechanics of persisting and realizing these resources. In some embodiments, the intent-based API system allows the users to define hierarchical API commands by using a declarative language that refers to a simplified hierarchical data model. Each hierarchical API command can define multiple SD resources at multiple resource levels in the SDDC without requiring earlier API commands to create certain SD resources before others. In fact, one hierarchical command can be used in some embodiments to define all the SD resources for one user (e.g., one tenant) of the SDDC (e.g., of a multi-tenant SDDC).

The API system of some embodiments leverages the hierarchy of the data model to provide a process for accepting, validating and realizing parts or the whole of the hierarchy in a single API invocation. This system leverages the inherent knowledge of the data model to identify dependencies and invoke the underlying services in the right order, both for persistence and realization of the intent. Also, all of the persistence is done in a single transaction, thus making sure that the entire intent is accepted as an atomic unit.

Accordingly, the API processing system determines whether the SD resources identified in the hierarchical API command are deployable. If so, the API processing system sends a confirmation that the API command has been successfully processed to a source that produced the hierarchical API command. On the other hand, when one or more SD resources in the API command are not deployable, the API processing system sends a message that the API command has not been successfully processed to the source that produced the hierarchical API command.

Hence, from a user's perspective, the hierarchical API command either succeeds or fails as a whole. Treating the hierarchical API command as one atomic unit is important from networking and security perspectives, as it ensure that unless all the necessary features are defined (e.g., security is defined) for the network, the network does not get realized. This atomic treatment of multiple, different SD resources has not been achievable in one API command to date. Instead, multiple commands have typically been used with the first command specifying a start of a series of transactions and an end command specifying the end of the series.

Once the API system determines that the SD resources in an API command are deployable, the API system uses an asynchronous process in some embodiments to deploy these resources (i.e., goes about realizing the user's intent) in the right order. More specifically, once a hierarchical API command is parsed and the user input regarding the SD resources is persisted to a database that stores the user's input as the desired state, the asynchronous realization process starts in some embodiments. This process works with one or more network, service or compute managers to deploy or update one or more network, service or compute resources based on a work order that is appropriate for the deployed resources.

FIG. 1 illustrates an example of a hierarchical API command 100. As shown, this command is expressed in a hierarchical JSON (Javascript Object Notation) format, but in other embodiments it can be expressed in other hierarchical formats such as XML (Extensible Markup Language) format. The hierarchical JSON format used is equivalent to a tree format. Each node of the tree corresponds to an SDDC resource and has a field that describes the resource type for that node. Each node has a special property that holds all the children for the node depicting the parent-child relationship. Child nodes can in turn have multiple children and this can go to any depth. Thus, each node can be a parent and a child at the same time (similar to a non-leaf node in a tree).

In FIG. 1 , each node has a property “resource type” that describes the node's type. Example types in some embodiments include Infra, Tenant, Domain, Group, CommunicationMap, CommunicationEntry, Provider, ProviderInterface, Network, Segment, LoadBalancer, etc. These are all different types of resources in a datacenter. A node can also have a property “Children” that holds all the children of the node. For instance, in FIG. 1 , the node of type “Domain” is a child of type “Infra” and has three children of two different types, which are “Group” and “CommunicationMap”

In some embodiments, Tenant refers to a tenant in a multi-tenant SDDC, Domain is the workload under a tenant, CommunicationMaps are security policies, and CommunicationEntry are the rules under a security policy. In some embodiments, each SD resource can be identified with a unique path from the root with all taxonomical parents included in the path. For example, a /vmware specifies all resources associated with a tenant VMware. A path /vmware/domains/Outlook specifies all Outlook workloads for the tenant VMware. A path /vmware/domains/Outlook/communication-maps/web-profile specifies the web-profile of the Outlook workloads of the tenant VMware. A path

-   -   /vmware/domains/Outlook/communicationmaps/web-profile/communication-entries/open-browser-access         specifies the open browser access of Outlook workload of the         tenant VMware. More generally, the format for the path for a         security policy can be specified as:         /<tenant-name>/domains/<workload-name>/communication-maps/<security-policy-name>/communication-entries/<rule-name>.

FIG. 2 illustrates a process 200 that the API processing system of some embodiments perform to process a hierarchical API command that it receives. As shown, the process 200 initially constructs (at 205) a type specific map for the API command. The type specific map stores each SD resource identified in the command according to its type. In some embodiments, the process performs a breadth-first traversal of the input API tree, classifies the input into different buckets based on the resource types, and stores the classified input in the type specific map.

Each key in the type specific map is a resource type, and the value for each key is a list of all resources of the specific type in the input API tree. Each node element is stored along with its parent. In sum, the input API tree is classified based on resource types, e.g., all domains in one bucket, all groups in another and so on. Below is the type specific map for the example illustrated in FIG. 1 .

Type Specific Map Domain Domain1 Group Group1, Group2 Communication Map cmp1

After generating the type specific map, the process 200 defines (at 210) an execution order for persisting the resources (SD resources) in the input API tree. In some embodiments, the execution order is a predefined ordered list of resource types. This list governs the order in which resources in the input tree should be persisted. If new type is introduced in the system, the execution order is dynamically updated to include the order for the new element. For the example of FIG. 1 , a sample execution order would be (1) Domain, (2) Group, and (3) Communication Map. This means domains should be created first then the groups and then communication maps.

Next, at 215, the process 200 uses a service provider registry to persist the SD resources in the API tree. The service provider registry is a map of resource types to callback handlers. The callback handlers are registered for each type in the system. The responsibility of a callback handler is to persist the type for which it is registered. As further described below, the callback handlers are implemented by deployment plugins in some embodiments. A deployment plugin is a module that plugs into an API processing system to handle the persistence of changes requested by received APIs and the deployment of the persisted changes. After 215, the process ends.

Below is an example of a service provider registry for the above-mentioned example. As shown, in the above example there are three types in the API call and three callback handlers are registered. For instance, DomainPersistenceService is registered for type “Domain” to indicate that DomainPersistenceService needs to be invoked to persist domain type.

Service Provider Registry Domain DomainPersistenceService Group GrupPersistenceServie CommunicationMap CMPService

FIG. 3 illustrates an example of the workflow for processing a hierarchical API in some embodiments. In this workflow, the hierarchical API command is processed by the system to persist entire user intent in one shot. The entire process is done as part of a single transaction ensuring intent is created as a whole and failure in process does not result in partial intent creation.

As shown, the user initially invokes the system by providing a hierarchical API command that provides an intent tree with SD resources at one or more resource levels of the SDDC. Next, the type specific map is created from the input tree as described above. The invocation order is then specified. Based on this order, the callback handlers are invoked to persist resources in execution order. The API processing system then returns a notification to indicate that the API command has been successfully persisted to a set of one or more configuration databases. After this notification, the API processing system then interacts with one or more network, compute and/or service managers to deploy the SD resources that have been persisted to the set of configuration databases based on the input in the API call.

FIG. 4 illustrates an example of the API processing system 400 of some embodiments of the invention. In this system, each tenant can create an SDDC cluster 402 that includes one or more SDDC instances 405, which can be considered to be separate environments. As shown, each SDDC instance 405 in some embodiments includes an API gateway 420, an API processor 425, a compute manager 410, a network manager 415, a controller 440, a template manager 427, a policy checker 423, a configuration data storage 435, and several deployment plugins 430.

In some embodiments, two or more of these components execute on two or more machines (e.g., VMs, containers, standalone servers, etc.) in one or more datacenters and communicate with each other through a network. In these or other embodiments, each SDDC instance includes multiple instances of each of these components for distributing the load and for high availability.

The compute manager 410 deploys and manages workload machines (e.g., workload VMs or containers). The network manager 415 on the other hand deploys network resources (e.g., software switches and routers) and middlebox service resources (e.g., service VMs and modules) in a datacenter. In some embodiments, the compute and network managers 410 and 415 use one or more controllers 440 to distribute the configuration data that is stored in one or more configuration data storages 435 to host computers, forwarding elements (e.g., software switches and routers executing on host computers, or standalone switches and routers), service machines (e.g., service VMs, service containers, other service modules, and standalone service appliances), and other resources in the SDDC.

The API gateway 420 redirects all API commands to the API service module 425, or to the UI manager 422 in some cases, based on URL patterns. The URL manager 422 processes API commands that are received through a graphical user interface and directs these commands to the API processor 425. The API processor 425 performs the processes illustrated in FIGS. 2 and 3 to ensure that the different requests that are part of a received hierarchical API are persisted to the configuration data storage(s) 435 and deployed in the correct order. The API processor 425 owns the user's desired state that it stores in its data storage 432. In some embodiments, the API processor 425 runs as a VM or container.

As shown, the API processor 425 in some embodiments uses the API template manager 427, which has access to several deployment templates that specify different API configurations for the SDDC resources. Through the template manager 427, users can select and modify a template (e.g., through API commands) to produce a complete hierarchical API. Based on this completed hierarchical API, the API processor 425 can then deploy, or update a previously deployed, set of SDDC resource, as further described below.

To deploy a resource, or update a previously deployed resource, based on a request in a received hierarchical API or a hierarchical API completed through the invocation of an API template with the required input, the API processor 425 in some embodiments parses the hierarchical API into one or more requests and uses the policy checking engine 423 to validate each request (i.e., to specify whether each request satisfies the constraints specified in the policies that are stored in the policy storage 424 and that are applicable to the resources referred to in the request).

In some embodiments, each policy in the policy storage 424 includes (1) a target that specifies a set of one or more datacenter resources to which the policy applies, and (2) an expression that specifies a constraint on operations on the specified resource set. The policies are expressed in a declarative format in some embodiments. Thus, for each request in a hierarchical API, the policy engine compares a set of attributes of the selected request's resource with a policy's target to determine whether the policy is applicable to the resource. After identifying one applicable policy, the policy checking engine determines whether the identified policy's expression specifies a constraint that requires the selected request to be rejected or allowed.

Through the deployment plugins 430, the API processor 425 persists the SD resources in the API calls in the configuration database 435. The deployment plugins 430 run as VMs or containers in some embodiments. Each plugin 430 is responsible for deploying one or more SD resource types. Examples of such types include data compute nodes (e.g., compute machines such as VMs or containers), distributed firewall rules, edge firewall rules, L2 and L3 forwarding elements (software switches and routers), security groups, VPN services, DHCP services, DNS services, load balancing services, etc.

To deploy these services, the plugins 430 interact with the computer manager 410 and the network manager 415, which, in turn, interact with one or more controllers 440. Through these managers and controllers, the plugins 430 distribute configuration data from the persistent database 435 to host computers and standalone network/service devices in an SDDC in order to direct these computers and devices to deploy the desired SD resources.

In some embodiments, there is one desired state and orchestration service (i.e., API processing module) per SDDC instance. This is a highly available service that is deployed in some embodiments in the form of a container or a VM. This service accepts user's intent and performs orchestration across different services. This service also owns the details of the enforcement points (compute and network managers) to which the policies need to be pushed down.

The deployment plugins 430 provide the realization of the intent. As mentioned above, each of these plugins in some embodiments is deployed as a separate service running in a separate container or VM. In some embodiments, some services are packaged together in a single container, but run as separate services in terms of design and communication. Since the orchestration is performed by the desired state service, each of the plugin services in some embodiments exposes a set of REST API endpoints that would be invoked. Also, the desired state service in some embodiments serves as the common service that returns the state of the realized resources across different services. This is the case even though in some embodiments the realized state data is updated in the data store by the plugin services.

Thus, execution of hierarchical API results in creation of desired state in one go. If the system is able to validate and persist whole of intent, a notification is sent (e.g., an http status code 200 OK is returned) to the source of the hierarchical API. After the intent is created, notifications are generated. These notifications are consumed asynchronously by deployment plugins. The deployment plugins then take care of realizing the intent. Status of realization can be queried from the system using status APIs.

The API processing system 400 in some embodiments provides users with the ability to query the intent in hierarchical fashion. For instance, in some embodiments, the system provides a GET API that facilitates the reading of entire intent in one go. A special flag is passed in URL parameter to request GET in hierarchical fashion. When the parameter is not passed, the GET in some embodiment would work as normal GET and a single resource is returned. Hierarchical GET in some embodiments can work on the entire tree or the parts of the tree, i.e. it can specify the node from which the hierarchy is to be retrieved, as the hierarchical GET can work from any level within the tree.

Another aspect of hierarchical GET is filtering in some embodiments. An administrator in these embodiments can filter out the intent tree to see only the types that she is interested in. This filtering can be a simple type-based filtering, e.g., the administrator can say GET the intent hierarchy for type “Domain”. In advanced filtering mechanism user can choose to retrieve intent based on features, e.g. the administrator can say GET all the resources in intent hierarchy related to firewall feature.

In some embodiments, user can perform hierarchical GET and club it with hierarchical POST. The administrator in some embodiments can retrieve the intent hierarchy, then modify and POST it back. This enables “import/export” use case. The administrator in some embodiments can also retrieve a hierarchical API and store it. Subsequently, the administrator can restore the previously retrieved intent.

FIGS. 5A-B illustrate another example of a hierarchical API. This API 500 has three operation requests 505-515 relating to a north-south router of an SDDC provider. A north-south router is a router that is placed at the north-south boundary of a physical or logical network of the SDDC in order to act as an ingress node to receive into this network packet from outside of the network or to supply from inside of the network packets to the outside of the network. The first request 505 is for the creation of the provider north-south router, the second request 510 is for defining the BGP services of this router, and the third request 515 is for defining the L3VPN services of this routers. As shown, the BGP and L3VPN services are defined as child resources of the north-south SDDC routers. Each request is defined in terms of the type of its associated resource as well as one or more other attributes of its associated resource.

FIG. 6 illustrates another example of a hierarchical API. This API 600 has five operation requests 605-625 to define five associated resources in an SDDC. As illustrated in FIG. 7 , these five resources are a provider north-south router 705, an uplink interface 710 for the provider router 705, a tenant router 715, and two L2 segments 720 and 725 in a network 700. The tenant router 715 connects the two L2 segments 720 and 725, which connect different sets of tenant workloads. In the example illustrated in FIG. 7 , the workloads are illustrated as VMs. The illustration in this figure uses dashed lines to draw the VMs as the VMs are not specifically defined in the hierarchical API 600.

The requests 605-625 in FIG. 6 correspond to the similarly numbered resources 705-725 in FIG. 7 . Specifically, the request 605 defines the north-south router 705, the request 610 defines an uplink interface 710, the request 615 defines a tenant router 715 and the requests 620 and 625 define two L2 segments 720 and 725. In the API 600, the tenant router 715 is referred to as the Network, while the provider router 705 is referred to as Provider.

FIG. 8 illustrates a hierarchical API template 800 that can be used to define the hierarchical API 600. As mentioned above, a template API provides a mechanism to specify a common set of requests that are often deployed together. The template API allows customers to deploy the common set of requests without having to define the API from scratch. To specify an actual API off of a template API, administrators just need to modify a limited number of fields called placeholder fields. From this perspective, a template API is a set of one or more requests (with respect to one or more resources) with blank fields or placeholders.

In some embodiments, the API template is a managed resource. It is represented by a list of placeholders and a body which is the API object. The API template 800 of FIG. 8 is a WebApp Template that defines the network components shown in FIG. 7 for a set of WebApp workloads. As shown, this template 800 includes the requests 605-625 of FIG. 6 . It also includes a template header 805 that provides a name 810 and a description 815 of the template along with a placeholder list 820. In this example, the placeholder list only has one set of placeholder values. The placeholder value set 825 in this example identifies an external logical switch to connect to the interface.

In some embodiments, a template can be managed through GET, PATCH, DELETE, and POST commands. For instance, in some embodiments, a GET/policy/templates returns a list of template identifiers in the database. A GET/policy/templates/<template-id> in some embodiments returns the template for a specific template identifier. Also, in some embodiments, a PATCH /policy/templates followed by a template JSON definition creates a new template. A DELETE /policy/templates/<template-id> in some embodiments deletes a template given a specific template identifier.

A POST /policy/templates/<template-id>?action=deploy is specified in some embodiments to define and invoke a hierarchical API based on a template API. This command deploys a template given a specific template identifier <template-id>. Arguments that provide the values of the placeholders in the template will be passed in the body of the POST request. For instance, to specify a hierarchical API based on the template 800 of FIG. 8 , the following POST command is provided in some embodiments.

  POST /templates/<WebAppTemplate>?action=deploy {  “placeholders” : [  {   “parameter_id”: “<external_ ls_id>”,   “parameter_value”: “LS5”  }  ]  }

In response to the POST command along with the placeholder arguments, the template manager 427 fetches the identified template, applies arguments that represent the placeholder values in order to define the hierarchical API, and then creates one or more request objects to identify each requested operation in the hierarchical API.

FIG. 9 illustrates a process 900 that the API processor 425 performs to process a hierarchical API regarding SD resources in the SDDC. The API processor 425 uses the policy checking engine 423 to perform this process.

In the process 900, the API processor 425 initially parses (at 905) the hierarchical API into a set of one or more requests for one or more SD resources in the SDDC. In some embodiments, the API might not only include different requests for different resources, but also might include multiple requests for the one SD resource. The received API can in some embodiments just include multiple different requests for one SD resource. Each request specifies one operation to be performed on a resource in some embodiments, while in other embodiments a request can specify multiple operations to be performed on a resource.

After parsing the API into one or more requests, the API processor 425 calls the policy checking engine 423 to validate each request (i.e., to specify whether each request satisfies all the constraints in all the policies that are applicable to the SD resources referred to in the API). Hence, at 910, the API processor 425 selects a request parsed from the API. The API processor 425 then directs (at 915) the policy checking engine 423 to identify one or more policies that are applicable to the selected request.

Each request is associated with a resource in the resource hierarchy of the SDDC. As mentioned above, each resource can be the parent resource of several other child resources in the resource hierarchy in some embodiments. Also, as mentioned above, each policy includes in a declarative format (1) a target that specifies a set of one or more datacenter resources to which the policy applies, and (2) an expression that specifies a constraint on operations on the specified resource set. The target of each policy in some embodiments includes a resource type for the specified resource set and a path prefix that identifies the specified resource set in the resource hierarchy of the datacenter.

Thus, at 915, the policy checking engine 423 in some embodiments compares a set of attributes of the selected request's resource with a policy's target to determine whether the policy is applicable to the resource. Specifically, to identify a policy that is applicable to the selected request's resource, the policy checking engine 423 compares one or more attributes of the selected request (e.g., the identifier of the request's associated resource) with one or more attributes specified in the target (e.g., path prefix and resource type) of each policy stored in the policy storage 424 to identify a policy with a matching attribute set (i.e., with an attribute set that matches the selected request's attribute set).

When the first resource that is the target operation of the received request is at a particular level in the resource hierarchy, the policy checking engine in some embodiments identifies a policy associated with the first resource by comparing the request's set of attributes with attribute sets of policies specified for the first resource or parent resources of the first resource on the resource hierarchy. For instance, for an API request to adjust web access to Outlook workloads, the policy checking engine 423 in some embodiments would identify policies specified for the Outlook workload, this workload's web-profile, and this workload's browser access as being applicable to the API request.

After identifying one applicable policy, the policy checking engine determines (at 920) whether the identified policy's expression specifies a constraint that requires the selected request to be rejected. To make this determination, the policy checking engine compares the attribute set of the selected request (e.g., data message flow attributes when the request relates to forwarding operations or service operations on data message flows between machines in the SDDC, deployment attributes when the request relates to deployment of machines or network elements, etc.) with attributes that are specified for the constraint in the applicable policy's expression to ascertain whether the selected request violates the policy's constraint.

Thus, while comparing the selected request's resource attribute set with the targets of policies to identify the applicability of the policies to the resource, the policy checking engine 423 compares the resource's attribute set with the expressions of the applicable policies to determine whether the request should be allowed or rejected. Examples of requested operations on target resources in some embodiments include creation or modification of forwarding rules for forwarding data messages, creation or modification of service rules for performing middlebox service operations on data messages, and deployments or modification of deployments of machine and/or network elements in the datacenter.

When the policy checking engine 423 determines (at 920) that the selected request violates the identified policy's constraint, it directs (at 925) the API processor 425 to reject the API and return a notification to the source of the API that it has been rejected. After the API processor 425 rejects the API, the process ends in some embodiments. In other embodiments, the process 900 does not end after it determines that the API violates at least one policy. In these embodiments, the API processor 425 directs the policy checking engine 423 to validate each request in the API so that it can provide a report to the API source to identify all the policies that the rejected API violated.

When the policy checking engine 423 determines (at 920) that the selected request does not violate the identified policy's constraint, it determines (at 930) whether any other policy in the policy store 424 is applicable to the selected request. If so, this engine 423 selects (at 935) this policy and transitions back to 920 to determine whether this policy's expression specifies a constraint that the request violates. The process loops through 920-935 so long as it can find policies that are applicable to the request and that it has not yet processed. This looping ends when the engine 423 identifies a policy that has a constraint that the request violates, or when the engine has finished analyzing policies that are applicable to the request.

When the policy checking engine 423 determines (at 930) that it has examined all policies that are applicable to the selected request, this engine informs (at 940) the API processor 425 that the selected request does not violate any policies. Next, at 942, the API processor 425 determines whether the API has any other parsed requests that have not yet been validated by the policy checking engine 423. If so, the API processor 425 selects (at 945) the next request and returns to 915 to direct the policy checking engine 423 to validate this newly selected request (i.e., to check whether this request violates any constraint of any policy that is applicable to the request).

When the API processor 425 determines (at 942) that the API has no other parsed requests that have not yet been validated by the policy checking engine 423, the API processing engine uses (at 950) one or more deployment plugins 430 to persist the configuration change needed for processing the request(s) of the processed hierarchical API (i.e., to specify or change previously specified configuration data regarding any resources affected by the API). These deployment engines specify or change previously specified configuration data in configuration data storage(s) 435.

Once the configuration data has been persisted to the configuration data storage(s) 435, the API processor 425 returns a notification to the source of the API to indicate that the API request has been processed. Next, at 960, the API processing engine directs one or more resource managers 410/415 to perform the operation(s) associated with the request(s) in the API. Instead of being directed by the API processing engine 425, the deployment plugins 430 direct the resource managers 410/415 in other embodiments to distribute new or modified configuration data sets from the configuration data storage(s) 435 to the resources.

In response to these notifications from the API processor 425 or the deployment plugins 430, the resource managers then perform the operation(s) associated with the request(s) in the API in these embodiments. A resource manager can perform its operation either by directly interacting with the datacenter resources (e.g., host computers) to define or modify the desired resource (e.g., firewall service machines or modules) or indirectly through local and/or remote controllers, which interact with the datacenter resources to define or modify the desired resources.

After 960, the process 900 ends.

Hierarchical API of some embodiments immensely simplifies user workflow to express intent. It gives the following major benefits to user. The administrator does not have to care about order of creating elements. Also, the whole of intent is created atomically. Entire intent is created in a single API call.

Many of the above-described features and applications are implemented as software processes that are specified as a set of instructions recorded on a computer readable storage medium (also referred to as computer readable medium). When these instructions are executed by one or more processing unit(s) (e.g., one or more processors, cores of processors, or other processing units), they cause the processing unit(s) to perform the actions indicated in the instructions. Examples of computer readable media include, but are not limited to, CD-ROMs, flash drives, RAM chips, hard drives, EPROMs, etc. The computer readable media does not include carrier waves and electronic signals passing wirelessly or over wired connections.

In this specification, the term “software” is meant to include firmware residing in read-only memory or applications stored in magnetic storage, which can be read into memory for processing by a processor. Also, in some embodiments, multiple software inventions can be implemented as sub-parts of a larger program while remaining distinct software inventions. In some embodiments, multiple software inventions can also be implemented as separate programs. Finally, any combination of separate programs that together implement a software invention described here is within the scope of the invention. In some embodiments, the software programs, when installed to operate on one or more electronic systems, define one or more specific machine implementations that execute and perform the operations of the software programs.

FIG. 10 conceptually illustrates a computer system 1000 with which some embodiments of the invention are implemented. The computer system 1000 can be used to implement any of the above-described hosts, controllers, and managers. As such, it can be used to execute any of the above described processes. This computer system includes various types of non-transitory machine readable media and interfaces for various other types of machine readable media. Computer system 1000 includes a bus 1005, processing unit(s) 1010, a system memory 1025, a read-only memory 1030, a permanent storage device 1035, input devices 1040, and output devices 1045.

The bus 1005 collectively represents all system, peripheral, and chipset buses that communicatively connect the numerous internal devices of the computer system 1000. For instance, the bus 1005 communicatively connects the processing unit(s) 1010 with the read-only memory 1030, the system memory 1025, and the permanent storage device 1035.

From these various memory units, the processing unit(s) 1010 retrieve instructions to execute and data to process in order to execute the processes of the invention. The processing unit(s) may be a single processor or a multi-core processor in different embodiments. The read-only-memory (ROM) 1030 stores static data and instructions that are needed by the processing unit(s) 1010 and other modules of the computer system. The permanent storage device 1035, on the other hand, is a read-and-write memory device. This device is a non-volatile memory unit that stores instructions and data even when the computer system 1000 is off. Some embodiments of the invention use a mass-storage device (such as a magnetic or optical disk and its corresponding disk drive) as the permanent storage device 1035.

Other embodiments use a removable storage device (such as a floppy disk, flash drive, etc.) as the permanent storage device. Like the permanent storage device 1035, the system memory 1025 is a read-and-write memory device. However, unlike storage device 1035, the system memory is a volatile read-and-write memory, such as random access memory. The system memory stores some of the instructions and data that the processor needs at runtime. In some embodiments, the invention's processes are stored in the system memory 1025, the permanent storage device 1035, and/or the read-only memory 1030. From these various memory units, the processing unit(s) 1010 retrieve instructions to execute and data to process in order to execute the processes of some embodiments.

The bus 1005 also connects to the input and output devices 1040 and 1045. The input devices enable the user to communicate information and select commands to the computer system. The input devices 1040 include alphanumeric keyboards and pointing devices (also called “cursor control devices”). The output devices 1045 display images generated by the computer system. The output devices include printers and display devices, such as cathode ray tubes (CRT) or liquid crystal displays (LCD). Some embodiments include devices such as touchscreens that function as both input and output devices.

Finally, as shown in FIG. 10 , bus 1005 also couples computer system 1000 to a network 1065 through a network adapter (not shown). In this manner, the computer can be a part of a network of computers (such as a local area network (“LAN”), a wide area network (“WAN”), or an Intranet), or a network of networks (such as the Internet). Any or all components of computer system 1000 may be used in conjunction with the invention.

Some embodiments include electronic components, such as microprocessors, storage and memory that store computer program instructions in a machine-readable or computer-readable medium (alternatively referred to as computer-readable storage media, machine-readable media, or machine-readable storage media). Some examples of such computer-readable media include RAM, ROM, read-only compact discs (CD-ROM), recordable compact discs (CD-R), rewritable compact discs (CD-RW), read-only digital versatile discs (e.g., DVD-ROM, dual-layer DVD-ROM), a variety of recordable/rewritable DVDs (e.g., DVD-RAM, DVD-RW, DVD+RW, etc.), flash memory (e.g., SD cards, mini-SD cards, micro-SD cards, etc.), magnetic and/or solid state hard drives, read-only and recordable Blu-Ray® discs, ultra-density optical discs, any other optical or magnetic media, and floppy disks. The computer-readable media may store a computer program that is executable by at least one processing unit and includes sets of instructions for performing various operations. Examples of computer programs or computer code include machine code, such as is produced by a compiler, and files including higher-level code that are executed by a computer, an electronic component, or a microprocessor using an interpreter.

While the above discussion primarily refers to microprocessor or multi-core processors that execute software, some embodiments are performed by one or more integrated circuits, such as application specific integrated circuits (ASICs) or field programmable gate arrays (FPGAs). In some embodiments, such integrated circuits execute instructions that are stored on the circuit itself.

As used in this specification, the terms “computer”, “server”, “processor”, and “memory” all refer to electronic or other technological devices. These terms exclude people or groups of people. For the purposes of the specification, the terms “display” or “displaying” mean displaying on an electronic device. As used in this specification, the terms “computer readable medium,” “computer readable media,” and “machine readable medium” are entirely restricted to tangible, physical objects that store information in a form that is readable by a computer. These terms exclude any wireless signals, wired download signals, and any other ephemeral or transitory signals.

While the invention has been described with reference to numerous specific details, one of ordinary skill in the art will recognize that the invention can be embodied in other specific forms without departing from the spirit of the invention. Thus, one of ordinary skill in the art would understand that the invention is not to be limited by the foregoing illustrative details, but rather is to be defined by the appended claims 

What is claimed is:
 1. A method of deploying resources in a software defined datacenter (SDDC), the method comprising: receiving a hierarchical API (application programming interface) command that specifies a plurality of software-defined (SD) resources at a plurality of resource levels of a resource hierarchy in the SDDC, said plurality of SD resources at the plurality of resource levels corresponding to a plurality of resource types including a tenant type, a workload type, and a security policy type; parsing the hierarchical API command to identify the plurality of SD resources at the plurality of resource levels, the identified plurality of SD resources comprising a tenant resource, a plurality of workload resources and a plurality of security policy resources; and deploying the identified plurality of SD resources.
 2. The method of claim 1, wherein the hierarchical API command is in a hierarchical JSON (Javascript Object Notation) or XML (Extensible Markup Language) format.
 3. The method of claim 1, wherein each of the resource types has at least a parent or child relationship with at least one other resource type; in the hierarchical API command each particular resource of a set of resources has at least a parent or child resource according to the resource type of the particular resource; and a description of each particular resource of a set of resources is contained within a description of the parent resource of the particular resource in the hierarchical API command.
 4. The method of claim 1, wherein the resource types further include a security rule type that is a child of the security policy type and the identified plurality of SD resources comprises a plurality of security rules.
 5. The method of claim 1, wherein the resource types further include a group type and the identified plurality of SD resources comprises at least one security group of the group type.
 6. The method of claim 1 further comprising: constructing a type specific map for the hierarchical API command, said type specific map storing each identified SD resource according to its type; defining an execution order for persisting the identified SD resources; and using the defined execution order to persist the identified SD resources in a set of one or more configuration storages.
 7. The method of claim 6, wherein the type specific map has a plurality of key-value pairs, each key corresponding to a resource type, and the value for each key is a list of all resources of the specific type in the hierarchical API command.
 8. The method of claim 7, wherein the execution order is a predefined ordered list of resource types.
 9. The method of claim 8, wherein the ordered list governs an order in which resources are to be persisted to the configuration storage.
 10. The method of claim 6 further comprising using compute, network and service managers to deploy the SD resources that have been persisted to the set of configuration storages.
 11. A non-transitory machine readable medium storing a program for deploying software-defined (SD) resources in a software defined datacenter (SDDC), the program comprising sets of instructions for: receiving a hierarchical API (application programming interface) command that specifies a plurality of software-defined (SD) resources at a plurality of resource levels of a resource hierarchy in the SDDC, said plurality of SD resources at the plurality of resource levels corresponding to a plurality of resource types including a tenant type, a workload type, and a security policy type; parsing the hierarchical API command to identify the plurality of SD resources at the plurality of resource levels, the identified plurality of SD resources comprising a tenant resource, a plurality of workload resources and a plurality of security policy resources; and deploying the identified plurality of SD resources in the SDDC.
 12. The non-transitory machine readable medium of claim 11, wherein the hierarchical API command is in a hierarchical JSON (Javascript Object Notation) or XML (Extensible Markup Language) format.
 13. The non-transitory machine readable medium of claim 11, wherein: each of the resource types has at least a parent or child relationship with at least one other resource type; in the hierarchical API command each particular resource of a set of resources has at least a parent or child resource according to the resource type of the particular resource; and a description of each particular resource of a set of resources is contained within a description of the parent resource of the particular resource in the hierarchical API command.
 14. The non-transitory machine readable medium of claim 11, wherein the resource types further include a security rule type that is a child of the security policy type and the identified plurality of SD resources comprises a plurality of security rules.
 15. The non-transitory machine readable medium of claim 11, wherein the resource types further include a group type and the identified plurality of SD resources comprises at least one security group of the group type.
 16. The non-transitory machine readable medium of claim 11, wherein the program further comprises set of instructions for: constructing a type specific map for the hierarchical API command, said type specific map storing each identified SD resource according to its type; defining an execution order for persisting the identified SD resources; and using the defined execution order to persist the identified SD resources in a set of one or more configuration storages.
 17. The non-transitory machine readable medium of claim 16, wherein the type specific map has a plurality of key-value pairs, each key corresponding to a resource type, and the value for each key is a list of all resources of the specific type in the hierarchical API command.
 18. The non-transitory machine readable medium of claim 17, wherein the execution order is a predefined ordered list of resource types.
 19. The non-transitory machine readable medium of claim 18, wherein the ordered list governs an order in which resources are to be persisted to the configuration storage.
 20. The non-transitory machine readable medium of claim 16, wherein the program further comprises a set of instructions using compute, network and service managers to deploy the SD resources that have been persisted to the set of configuration storages. 